/*
 * Copyright 1999-2018 Alibaba Group Holding Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.alibaba.nacos.client.naming.remote;

import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.naming.pojo.Instance;
import com.alibaba.nacos.api.naming.pojo.ListView;
import com.alibaba.nacos.api.naming.pojo.Service;
import com.alibaba.nacos.api.naming.pojo.ServiceInfo;
import com.alibaba.nacos.api.selector.AbstractSelector;
import com.alibaba.nacos.common.lifecycle.Closeable;

import java.util.Set;

/**
 * 名称服务客户端代理.
 *
 * @author xiweng.yy
 */
public interface NamingClientProxy extends Closeable {

    /**
     * 注册服务实例.
     *
     * @param serviceName 服务名称
     * @param groupName   分组名称
     * @param instance    待注册实例
     * @throws NacosException nacos exception
     */
    void registerService(String serviceName, String groupName, Instance instance) throws NacosException;

    /**
     * 注销服务实例.
     *
     * @param serviceName 服务名称
     * @param groupName   分组名称
     * @param instance    待注销实例
     * @throws NacosException nacos exception
     */
    void deregisterService(String serviceName, String groupName, Instance instance) throws NacosException;

    /**
     * 更新实例.
     *
     * @param serviceName 服务名称
     * @param groupName   分组名称
     * @param instance    待更新实例
     * @throws NacosException nacos exception
     */
    void updateInstance(String serviceName, String groupName, Instance instance) throws NacosException;

    /**
     * 查询实例列表.
     *
     * @param serviceName 服务名称
     * @param groupName   分组名称
     * @param clusters    集群列表
     * @param udpPort     udp端口
     * @param healthyOnly 是否只查询健康实例
     * @return 实例列表
     * @throws NacosException nacos exception
     */
    ServiceInfo queryInstancesOfService(String serviceName, String groupName, String clusters, int udpPort, boolean healthyOnly) throws NacosException;

    /**
     * 查询服务信息.
     *
     * @param serviceName 服务名称
     * @param groupName   分组名称
     * @return 服务信息
     * @throws NacosException nacos exception
     */
    Service queryService(String serviceName, String groupName) throws NacosException;

    /**
     * 创建服务.
     *
     * @param service  服务信息
     * @param selector 选择器
     * @throws NacosException nacos exception
     */
    void createService(Service service, AbstractSelector selector) throws NacosException;

    /**
     * 删除服务.
     *
     * @param serviceName 服务名称
     * @param groupName   分组名称
     * @return 删除成功返回true，失败返回false
     * @throws NacosException nacos exception
     */
    boolean deleteService(String serviceName, String groupName) throws NacosException;

    /**
     * 更新服务.
     *
     * @param service  服务信息
     * @param selector 选择器
     * @throws NacosException nacos exception
     */
    void updateService(Service service, AbstractSelector selector) throws NacosException;

    /**
     * 获取服务列表.
     *
     * @param pageNo    页码
     * @param pageSize  每页条数
     * @param groupName 分组名称
     * @param selector  选择器
     * @return 服务列表
     * @throws NacosException nacos exception
     */
    ListView<String> getServiceList(int pageNo, int pageSize, String groupName, AbstractSelector selector) throws NacosException;

    /**
     * 订阅服务.
     *
     * @param serviceName 服务名称
     * @param groupName   分组名称
     * @param clusters    集群列表
     * @return 当前订阅的服务信息
     * @throws NacosException nacos exception
     */
    ServiceInfo subscribe(String serviceName, String groupName, String clusters) throws NacosException;

    /**
     * 取消订阅服务.
     *
     * @param serviceName 服务名称
     * @param groupName   分组名称
     * @param clusters    集群列表
     * @throws NacosException nacos exception
     */
    void unsubscribe(String serviceName, String groupName, String clusters) throws NacosException;

    /**
     * Update beat info.
     *
     * @param modifiedInstances modified instances
     */
    void updateBeatInfo(Set<Instance> modifiedInstances);

    /**
     * 检测服务健康状态.
     *
     * @return true if server is healthy
     */
    boolean serverHealthy();
}
